package com.xuecheng.swagger.controller;

import com.xuecheng.swagger.entity.Student;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestParam;

//Api:对于controller描述
//ApiOperation ： 对方法进行表述
//ApiImplicitParams: 描述多个参数
//ApiImplicitParam：描述单个参数

@Api(value = "hello api",tags = "Hello api 接口路径地址-tags",description = "Hello api 接口路径地址-des")
public interface HelloApi {


    @ApiOperation("修改学员信息")
    @ApiImplicitParams({
           @ApiImplicitParam(name="id",value = "学员Id",required = true,dataType = "String",paramType = "path"),
           @ApiImplicitParam(name="name",value = "学员名称",required = true,dataType = "String",paramType = "query")
    })
    Student modifyStudentByNum(@PathVariable("id") String id,
                                @RequestParam("name") String name,
                                @RequestBody Student student);
}